<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../../../print.css" type="text/css" media="print">
<meta content="EsuApi,com.emc.esu.api.EsuApi,createObject,createObjectOnPath,deleteObject,deleteUserMetadata,deleteVersion,getAcl,getAllMetadata,getListableTags,getObjectInfo,getServiceInformation,getShareableUrl,getSystemMetadata,getUserMetadata,listDirectory,listObjects,listObjectsWithMetadata,listUserMetadataTags,listVersions,queryObjects,readObject,rename,restoreVersion,setAcl,setUserMetadata,updateObject,versionObject" name="keywords">
<title>com.emc.esu.api.EsuApi</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'EsuApi - API Documentation';
				var baseRef = '../../../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">EMC ESU API for Adobe Flex</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../../../all-classes.html')" href="../../../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../../all-classes.html')" href="../../../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../../index-list.html')" href="../../../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../../../index.html?com/emc/esu/api/EsuApi.html&amp;com/emc/esu/api/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Interface&nbsp;EsuApi</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#methodSummary">Methods</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Interface EsuApi"); titleBar_setSubNav(false,false,false,false,false,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">com.emc.esu.api</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Interface</td><td class="classSignature">public interface EsuApi</td>
</tr>
<tr>
<td class="classHeaderTableLabel">Implementors</td><td><a href="rest/EsuRestApi.html">EsuRestApi</a>, <a href="rest/EsuRetryRestApi.html">EsuRetryRestApi</a></td>
</tr>
</table>
<p></p>
  This interface defines the basic operations available through the ESU web
  services.
  <p></p>
<br>
<hr>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#createObject()">createObject</a>(acl:<a href="Acl.html">Acl</a>, metadata:<a href="MetadataList.html">MetadataList</a>, data:ByteArray, mimeType:String, callback:Function, state:Object, checksum:<a href="Checksum.html">Checksum</a> = null):void</div>
<div class="summaryTableDescription">
      Creates a new object in the cloud.</div>
</td><td class="summaryTableOwnerCol">EsuApi</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#createObjectOnPath()">createObjectOnPath</a>(path:<a href="ObjectPath.html">ObjectPath</a>, acl:<a href="Acl.html">Acl</a>, metadata:<a href="MetadataList.html">MetadataList</a>, data:ByteArray, mimeType:String, callback:Function, state:Object, checksum:<a href="Checksum.html">Checksum</a> = null):void</div>
<div class="summaryTableDescription">
      Creates a new object in the cloud on the given path.</div>
</td><td class="summaryTableOwnerCol">EsuApi</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#deleteObject()">deleteObject</a>(id:<a href="Identifier.html">Identifier</a>, callback:Function, state:Object):void</div>
<div class="summaryTableDescription">
      Deletes an object from the cloud.</div>
</td><td class="summaryTableOwnerCol">EsuApi</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#deleteUserMetadata()">deleteUserMetadata</a>(id:<a href="Identifier.html">Identifier</a>, tags:<a href="MetadataTags.html">MetadataTags</a>, callback:Function, state:Object):void</div>
<div class="summaryTableDescription">
      Deletes metadata items from an object.</div>
</td><td class="summaryTableOwnerCol">EsuApi</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#deleteVersion()">deleteVersion</a>(id:<a href="ObjectId.html">ObjectId</a>, callback:Function, state:Object):void</div>
<div class="summaryTableDescription">
      Deletes a version
      </div>
</td><td class="summaryTableOwnerCol">EsuApi</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getAcl()">getAcl</a>(id:<a href="Identifier.html">Identifier</a>, callback:Function, state:Object):void</div>
<div class="summaryTableDescription">
      Returns an object's ACL
      </div>
</td><td class="summaryTableOwnerCol">EsuApi</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getAllMetadata()">getAllMetadata</a>(id:<a href="Identifier.html">Identifier</a>, callback:Function, state:Object):void</div>
<div class="summaryTableDescription">
      Returns all the metadata for the object: system metadata, user
      metadata, and the ACL as a ObjectMetadata object.</div>
</td><td class="summaryTableOwnerCol">EsuApi</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getListableTags()">getListableTags</a>(tag:Object, callback:Function, state:Object):void</div>
<div class="summaryTableDescription">
      Returns a list of the tags that are listable the current user's tennant.</div>
</td><td class="summaryTableOwnerCol">EsuApi</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getObjectInfo()">getObjectInfo</a>(id:<a href="Identifier.html">Identifier</a>, callback:Function, state:Object):void</div>
<div class="summaryTableDescription">
   Returns the replica information for the object.</div>
</td><td class="summaryTableOwnerCol">EsuApi</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getServiceInformation()">getServiceInformation</a>(callback:Function, state:Object):void</div>
<div class="summaryTableDescription">
      Gets the current Atmos server information.</div>
</td><td class="summaryTableOwnerCol">EsuApi</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getShareableUrl()">getShareableUrl</a>(id:<a href="Identifier.html">Identifier</a>, expiration:Date):String</div>
<div class="summaryTableDescription">
      An Atmos user (UID) can construct a pre-authenticated URL to an 
      object, which may then be used by anyone to retrieve the 
      object (e.g., through a browser).</div>
</td><td class="summaryTableOwnerCol">EsuApi</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getSystemMetadata()">getSystemMetadata</a>(id:<a href="Identifier.html">Identifier</a>, tags:<a href="MetadataTags.html">MetadataTags</a>, callback:Function, state:Object):void</div>
<div class="summaryTableDescription">
      Fetches the system metadata for the object.</div>
</td><td class="summaryTableOwnerCol">EsuApi</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getUserMetadata()">getUserMetadata</a>(id:<a href="Identifier.html">Identifier</a>, tags:<a href="MetadataTags.html">MetadataTags</a>, callback:Function, state:Object):void</div>
<div class="summaryTableDescription">
      Fetches the user metadata for the object.</div>
</td><td class="summaryTableOwnerCol">EsuApi</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#listDirectory()">listDirectory</a>(path:<a href="ObjectPath.html">ObjectPath</a>, callback:Function, state:Object):void</div>
<div class="summaryTableDescription">
      Returns all the objects in the specified directory as an array
      of DirectoryEntry objects.</div>
</td><td class="summaryTableOwnerCol">EsuApi</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#listObjects()">listObjects</a>(tag:Object, callback:Function, state:Object):void</div>
<div class="summaryTableDescription">
      Lists all objects with the given tag.</div>
</td><td class="summaryTableOwnerCol">EsuApi</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#listObjectsWithMetadata()">listObjectsWithMetadata</a>(tag:Object, callback:Function, state:Object):void</div>
<div class="summaryTableDescription">
      Lists all objects with the given tag.</div>
</td><td class="summaryTableOwnerCol">EsuApi</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#listUserMetadataTags()">listUserMetadataTags</a>(id:<a href="Identifier.html">Identifier</a>, callback:Function, state:Object):void</div>
<div class="summaryTableDescription">
      Returns the list of user metadata tags assigned to the object.</div>
</td><td class="summaryTableOwnerCol">EsuApi</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#listVersions()">listVersions</a>(id:<a href="Identifier.html">Identifier</a>, callback:Function, state:Object):void</div>
<div class="summaryTableDescription">
      Lists the versions of an object.</div>
</td><td class="summaryTableOwnerCol">EsuApi</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#queryObjects()">queryObjects</a>(xquery:String, callback:Function, state:Object):void</div>
<div class="summaryTableDescription">
      Executes a query for objects matching the specified XQuery string.</div>
</td><td class="summaryTableOwnerCol">EsuApi</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#readObject()">readObject</a>(id:<a href="Identifier.html">Identifier</a>, extent:<a href="Extent.html">Extent</a>, buffer:ByteArray, callback:Function, state:Object, checksum:<a href="Checksum.html">Checksum</a> = null):void</div>
<div class="summaryTableDescription">
      Reads an object's content.</div>
</td><td class="summaryTableOwnerCol">EsuApi</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#rename()">rename</a>(source:<a href="ObjectPath.html">ObjectPath</a>, destination:<a href="ObjectPath.html">ObjectPath</a>, force:Boolean, callback:Function, state:Object):void</div>
<div class="summaryTableDescription">
      Renames a file or directory within the namespace.</div>
</td><td class="summaryTableOwnerCol">EsuApi</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#restoreVersion()">restoreVersion</a>(id:<a href="Identifier.html">Identifier</a>, vId:<a href="ObjectId.html">ObjectId</a>, callback:Function, state:Object):void</div>
<div class="summaryTableDescription">
      Restores a version of an object to the base revision (i.e.</div>
</td><td class="summaryTableOwnerCol">EsuApi</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#setAcl()">setAcl</a>(id:<a href="Identifier.html">Identifier</a>, acl:<a href="Acl.html">Acl</a>, callback:Function, state:Object):void</div>
<div class="summaryTableDescription">
      Sets (overwrites) the ACL on the object.</div>
</td><td class="summaryTableOwnerCol">EsuApi</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#setUserMetadata()">setUserMetadata</a>(id:<a href="Identifier.html">Identifier</a>, metadata:<a href="MetadataList.html">MetadataList</a>, callback:Function, state:Object):void</div>
<div class="summaryTableDescription">
      Writes the metadata into the object.</div>
</td><td class="summaryTableOwnerCol">EsuApi</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#updateObject()">updateObject</a>(id:<a href="Identifier.html">Identifier</a>, acl:<a href="Acl.html">Acl</a>, metadata:<a href="MetadataList.html">MetadataList</a>, extent:<a href="Extent.html">Extent</a>, data:ByteArray, mimeType:String, callback:Function, state:Object, checksum:<a href="Checksum.html">Checksum</a> = null):void</div>
<div class="summaryTableDescription">
      Updates an object in the cloud.</div>
</td><td class="summaryTableOwnerCol">EsuApi</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#versionObject()">versionObject</a>(id:<a href="Identifier.html">Identifier</a>, callback:Function, state:Object):void</div>
<div class="summaryTableDescription">
      Creates a new immutable version of an object.</div>
</td><td class="summaryTableOwnerCol">EsuApi</td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="methodDetail"></a>
<div class="detailSectionHeader">Method detail</div>
<a name="createObject()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">createObject</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
</tr>
</table>
<div class="detailBody">
<code>public function createObject(acl:<a href="Acl.html">Acl</a>, metadata:<a href="MetadataList.html">MetadataList</a>, data:ByteArray, mimeType:String, callback:Function, state:Object, checksum:<a href="Checksum.html">Checksum</a> = null):void</code><p>
      Creates a new object in the cloud.  The ID of the new object
      will be returned through the callback.
      </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">acl</span>:<a href="Acl.html">Acl</a></code> &mdash; Access control list for the new object.  May be null
      to use a default ACL
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">metadata</span>:<a href="MetadataList.html">MetadataList</a></code> &mdash; Metadata for the new object.  May be null for
      no metadata.
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">data</span>:ByteArray</code> &mdash; The initial contents of the object.  May be appended
      to later.  May be null to create an object with no content.
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">mimeType</span>:String</code> &mdash; the MIME type of the content.  Optional, 
      may be null.  If data is non-null and mimeType is null, the MIME
      type will default to application/octet-stream.
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">callback</span>:Function</code> &mdash; a callback function with the signature 
      <code>function x( state:EsuCallbackState );</code>
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">state</span>:Object</code> &mdash; an optional user-defined state object to be passed to
      the callback method through the EsuCallbackState object.
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">checksum</span>:<a href="Checksum.html">Checksum</a></code> (default = <code>null</code>)<code></code> &mdash; if not null, use the Checksum object to compute
      the checksum for the create object request.  If appending
      to the object with subsequent requests, use the same
      checksum object for each request.
      </td>
</tr>
</table>
</div>
<a name="createObjectOnPath()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">createObjectOnPath</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function createObjectOnPath(path:<a href="ObjectPath.html">ObjectPath</a>, acl:<a href="Acl.html">Acl</a>, metadata:<a href="MetadataList.html">MetadataList</a>, data:ByteArray, mimeType:String, callback:Function, state:Object, checksum:<a href="Checksum.html">Checksum</a> = null):void</code><p>
      Creates a new object in the cloud on the given path.  The
      ID of the new object will be returned through the callback.
      </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">path</span>:<a href="ObjectPath.html">ObjectPath</a></code> &mdash; ObjectPath the path to create the new object on.
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">acl</span>:<a href="Acl.html">Acl</a></code> &mdash; Access control list for the new object.  May be null
      to use a default ACL
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">metadata</span>:<a href="MetadataList.html">MetadataList</a></code> &mdash; Metadata for the new object.  May be null for
      no metadata.
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">data</span>:ByteArray</code> &mdash; The initial contents of the object.  May be appended
      to later.  May be null to create an object with no content.
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">mimeType</span>:String</code> &mdash; the MIME type of the content.  Optional, 
      may be null.  If data is non-null and mimeType is null, the MIME
      type will default to application/octet-stream.
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">callback</span>:Function</code> &mdash; a callback function with the signature 
      <code>function x( state:EsuCallbackState );</code>
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">state</span>:Object</code> &mdash; an optional user-defined state object to be passed to
      the callback method through the EsuCallbackState object.
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">checksum</span>:<a href="Checksum.html">Checksum</a></code> (default = <code>null</code>)<code></code> &mdash; if not null, use the Checksum object to compute
      the checksum for the create object request.  If appending
      to the object with subsequent requests, use the same
      checksum object for each request.
      </td>
</tr>
</table>
</div>
<a name="deleteObject()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">deleteObject</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function deleteObject(id:<a href="Identifier.html">Identifier</a>, callback:Function, state:Object):void</code><p>
      Deletes an object from the cloud.
      </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">id</span>:<a href="Identifier.html">Identifier</a></code> &mdash; the identifier of the object to delete.
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">callback</span>:Function</code> &mdash; a callback function with the signature 
      <code>function x( state:EsuCallbackState );</code>
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">state</span>:Object</code> &mdash; an optional user-defined state object to be passed to
      the callback method through the EsuCallbackState object.
      </td>
</tr>
</table>
</div>
<a name="deleteUserMetadata()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">deleteUserMetadata</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function deleteUserMetadata(id:<a href="Identifier.html">Identifier</a>, tags:<a href="MetadataTags.html">MetadataTags</a>, callback:Function, state:Object):void</code><p>
      Deletes metadata items from an object.
      </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">id</span>:<a href="Identifier.html">Identifier</a></code> &mdash; the identifier of the object whose metadata to 
      delete.
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">tags</span>:<a href="MetadataTags.html">MetadataTags</a></code> &mdash; the list of metadata tags to delete.
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">callback</span>:Function</code> &mdash; a callback function with the signature 
      <code>function x( state:EsuCallbackState );</code>
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">state</span>:Object</code> &mdash; an optional user-defined state object to be passed to
      the callback method through the EsuCallbackState object.
      </td>
</tr>
</table>
</div>
<a name="deleteVersion()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">deleteVersion</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function deleteVersion(id:<a href="ObjectId.html">ObjectId</a>, callback:Function, state:Object):void</code><p>
      Deletes a version
      </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">id</span>:<a href="ObjectId.html">ObjectId</a></code> &mdash; the version object to delete
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">callback</span>:Function</code> &mdash; a callback function with the signature 
      <code>function x( state:EsuCallbackState );</code>
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">state</span>:Object</code> &mdash; an optional user-defined state object to be passed to
      the callback method through the EsuCallbackState object.
      </td>
</tr>
</table>
</div>
<a name="getAcl()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getAcl</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getAcl(id:<a href="Identifier.html">Identifier</a>, callback:Function, state:Object):void</code><p>
      Returns an object's ACL
      </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">id</span>:<a href="Identifier.html">Identifier</a></code> &mdash; the identifier of the object whose ACL to read
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">callback</span>:Function</code> &mdash; a callback function with the signature 
      <code>function x( state:EsuCallbackState );</code>
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">state</span>:Object</code> &mdash; an optional user-defined state object to be passed to
      the callback method through the EsuCallbackState object.
      </td>
</tr>
</table>
</div>
<a name="getAllMetadata()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getAllMetadata</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getAllMetadata(id:<a href="Identifier.html">Identifier</a>, callback:Function, state:Object):void</code><p>
      Returns all the metadata for the object: system metadata, user
      metadata, and the ACL as a ObjectMetadata object.
      </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">id</span>:<a href="Identifier.html">Identifier</a></code> &mdash; the object whose metadata to get
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">callback</span>:Function</code> &mdash; a callback function with the signature 
      <code>function x( state:EsuCallbackState );</code>
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">state</span>:Object</code> &mdash; an optional user-defined state object to be passed to
      the callback method through the EsuCallbackState object.
      </td>
</tr>
</table>
</div>
<a name="getListableTags()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getListableTags</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getListableTags(tag:Object, callback:Function, state:Object):void</code><p>
      Returns a list of the tags that are listable the current user's tennant.
      </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">tag</span>:Object</code> &mdash; optional.  If specified, the list will be limited to the tags
      under the specified tag.  If null, only top level tags will be returned.
      May be a MetadataTag object or a String containing the tag name.
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">callback</span>:Function</code> &mdash; a callback function with the signature 
      <code>function x( state:EsuCallbackState );</code>
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">state</span>:Object</code> &mdash; an optional user-defined state object to be passed to
      the callback method through the EsuCallbackState object.
      </td>
</tr>
</table>
</div>
<a name="getObjectInfo()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getObjectInfo</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getObjectInfo(id:<a href="Identifier.html">Identifier</a>, callback:Function, state:Object):void</code><p>
   Returns the replica information for the object.
      </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">id</span>:<a href="Identifier.html">Identifier</a></code> &mdash; the object whose metadata to get
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">callback</span>:Function</code> &mdash; a callback function with the signature 
      <code>function x( state:EsuCallbackState );</code>
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">state</span>:Object</code> &mdash; an optional user-defined state object to be passed to
      the callback method through the EsuCallbackState object.
   </td>
</tr>
</table>
</div>
<a name="getServiceInformation()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getServiceInformation</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getServiceInformation(callback:Function, state:Object):void</code><p>
      Gets the current Atmos server information.  Currently, this simply
      returns the version of Atmos that is running.
      </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">callback</span>:Function</code> &mdash; a callback function with the signature 
      <code>function x( state:EsuCallbackState );</code>
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">state</span>:Object</code> &mdash; an optional user-defined state object to be passed to
      the callback method through the EsuCallbackState object.
      </td>
</tr>
</table>
</div>
<a name="getShareableUrl()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getShareableUrl</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getShareableUrl(id:<a href="Identifier.html">Identifier</a>, expiration:Date):String</code><p>
      An Atmos user (UID) can construct a pre-authenticated URL to an 
      object, which may then be used by anyone to retrieve the 
      object (e.g., through a browser). This allows an Atmos user 
      to let a non-Atmos user download a specific object. The 
      entire object/file is read.
      
      This method is synchronous, therefore no callback is needed.
      
      </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">id</span>:<a href="Identifier.html">Identifier</a></code> &mdash; the object to generate the URL for
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">expiration</span>:Date</code> &mdash; the expiration date of the URL
      </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>String</code> &mdash; a URL that can be used to share the object's content
      </td>
</tr>
</table>
</div>
<a name="getSystemMetadata()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getSystemMetadata</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getSystemMetadata(id:<a href="Identifier.html">Identifier</a>, tags:<a href="MetadataTags.html">MetadataTags</a>, callback:Function, state:Object):void</code><p>
      Fetches the system metadata for the object.
      </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">id</span>:<a href="Identifier.html">Identifier</a></code> &mdash; the identifier of the object whose system metadata
      to fetch.
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">tags</span>:<a href="MetadataTags.html">MetadataTags</a></code> &mdash; A list of system metadata tags to fetch.  Optional.
      Default value is null to fetch all system metadata.
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">callback</span>:Function</code> &mdash; a callback function with the signature 
      <code>function x( state:EsuCallbackState );</code>
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">state</span>:Object</code> &mdash; an optional user-defined state object to be passed to
      the callback method through the EsuCallbackState object.
      </td>
</tr>
</table>
</div>
<a name="getUserMetadata()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getUserMetadata</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getUserMetadata(id:<a href="Identifier.html">Identifier</a>, tags:<a href="MetadataTags.html">MetadataTags</a>, callback:Function, state:Object):void</code><p>
      Fetches the user metadata for the object.
      </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">id</span>:<a href="Identifier.html">Identifier</a></code> &mdash; the identifier of the object whose user metadata
      to fetch.
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">tags</span>:<a href="MetadataTags.html">MetadataTags</a></code> &mdash; A list of user metadata tags to fetch.  Optional.  If null,
      all user metadata will be fetched.
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">callback</span>:Function</code> &mdash; a callback function with the signature 
      <code>function x( state:EsuCallbackState );</code>
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">state</span>:Object</code> &mdash; an optional user-defined state object to be passed to
      the callback method through the EsuCallbackState object.
      </td>
</tr>
</table>
</div>
<a name="listDirectory()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">listDirectory</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function listDirectory(path:<a href="ObjectPath.html">ObjectPath</a>, callback:Function, state:Object):void</code><p>
      Returns all the objects in the specified directory as an array
      of DirectoryEntry objects.
      </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">path</span>:<a href="ObjectPath.html">ObjectPath</a></code> &mdash; the object whose metadata to get
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">callback</span>:Function</code> &mdash; a callback function with the signature 
      <code>function x( state:EsuCallbackState );</code>
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">state</span>:Object</code> &mdash; an optional user-defined state object to be passed to
      the callback method through the EsuCallbackState object.
      </td>
</tr>
</table>
</div>
<a name="listObjects()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">listObjects</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function listObjects(tag:Object, callback:Function, state:Object):void</code><p>
      Lists all objects with the given tag.
      </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">tag</span>:Object</code> &mdash; the tag to search for.  May be a MetadataTag object
      or a String containing the tag name.
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">callback</span>:Function</code> &mdash; a callback function with the signature 
      <code>function x( state:EsuCallbackState );</code>
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">state</span>:Object</code> &mdash; an optional user-defined state object to be passed to
      the callback method through the EsuCallbackState object.
      </td>
</tr>
</table>
</div>
<a name="listObjectsWithMetadata()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">listObjectsWithMetadata</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function listObjectsWithMetadata(tag:Object, callback:Function, state:Object):void</code><p>
      Lists all objects with the given tag.  Returns the IDs and metadata
      of all objects matching the tag.
      </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">tag</span>:Object</code> &mdash; the tag to search for.  May be a MetadataTag object
      or a String containing the tag name.
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">callback</span>:Function</code> &mdash; a callback function with the signature 
      <code>function x( state:EsuCallbackState );</code>
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">state</span>:Object</code> &mdash; an optional user-defined state object to be passed to
      the callback method through the EsuCallbackState object.
      </td>
</tr>
</table>
</div>
<a name="listUserMetadataTags()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">listUserMetadataTags</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function listUserMetadataTags(id:<a href="Identifier.html">Identifier</a>, callback:Function, state:Object):void</code><p>
      Returns the list of user metadata tags assigned to the object.
      </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">id</span>:<a href="Identifier.html">Identifier</a></code> &mdash; the object whose metadata tags to list
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">callback</span>:Function</code> &mdash; a callback function with the signature 
      <code>function x( state:EsuCallbackState );</code>
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">state</span>:Object</code> &mdash; an optional user-defined state object to be passed to
      the callback method through the EsuCallbackState object.
      </td>
</tr>
</table>
</div>
<a name="listVersions()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">listVersions</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function listVersions(id:<a href="Identifier.html">Identifier</a>, callback:Function, state:Object):void</code><p>
      Lists the versions of an object.
      </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">id</span>:<a href="Identifier.html">Identifier</a></code> &mdash; the object whose versions to list.
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">callback</span>:Function</code> &mdash; a callback function with the signature 
      <code>function x( state:EsuCallbackState );</code>
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">state</span>:Object</code> &mdash; an optional user-defined state object to be passed to
      the callback method through the EsuCallbackState object.
      </td>
</tr>
</table>
</div>
<a name="queryObjects()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">queryObjects</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function queryObjects(xquery:String, callback:Function, state:Object):void</code><p>
      Executes a query for objects matching the specified XQuery string.
      </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">xquery</span>:String</code> &mdash; the XQuery string to execute against the cloud.
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">callback</span>:Function</code> &mdash; a callback function with the signature 
      <code>function x( state:EsuCallbackState );</code>
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">state</span>:Object</code> &mdash; an optional user-defined state object to be passed to
      the callback method through the EsuCallbackState object.
      </td>
</tr>
</table>
</div>
<a name="readObject()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">readObject</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function readObject(id:<a href="Identifier.html">Identifier</a>, extent:<a href="Extent.html">Extent</a>, buffer:ByteArray, callback:Function, state:Object, checksum:<a href="Checksum.html">Checksum</a> = null):void</code><p>
      Reads an object's content.
      </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">id</span>:<a href="Identifier.html">Identifier</a></code> &mdash; the identifier of the object whose content to read.
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">extent</span>:<a href="Extent.html">Extent</a></code> &mdash; the portion of the object data to read.  Optional.
      Default is null to read the entire object.
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">buffer</span>:ByteArray</code> &mdash; the buffer to use to read the extent.  Must be large
      enough to read the response or an error will be thrown.  If null,
      a buffer will be allocated to hold the response data.  If you pass
      a buffer that is larger than the extent, only extent.getSize() bytes
      will be valid.
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">callback</span>:Function</code> &mdash; a callback function with the signature 
      <code>function x( state:EsuCallbackState );</code>
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">state</span>:Object</code> &mdash; an optional user-defined state object to be passed to
      the callback method through the EsuCallbackState object.
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">checksum</span>:<a href="Checksum.html">Checksum</a></code> (default = <code>null</code>)<code></code> &mdash; if not null, the given checksum object will be used
      to verify checksums during the read operation.  Note that only erasure
      coded objects will return checksums ndif you're reading the object
      in chunks, you'll have to read the data back sequentially to keep
      the checksum consistent.  If the read operation does not return
      a checksum from the server, the checksum operation will be skipped.
      </td>
</tr>
</table>
</div>
<a name="rename()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">rename</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function rename(source:<a href="ObjectPath.html">ObjectPath</a>, destination:<a href="ObjectPath.html">ObjectPath</a>, force:Boolean, callback:Function, state:Object):void</code><p>
      Renames a file or directory within the namespace.
      </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">source</span>:<a href="ObjectPath.html">ObjectPath</a></code> &mdash; The file or directory to rename
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">destination</span>:<a href="ObjectPath.html">ObjectPath</a></code> &mdash; The new path for the file or directory
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">force</span>:Boolean</code> &mdash; If true, the desination file or 
      directory will be overwritten.  Directories must be empty to be 
      overwritten.  Also note that overwrite operations on files are
      not synchronous; a delay may be required before the object is
      available at its destination.
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">callback</span>:Function</code> &mdash; a callback function with the signature 
      <code>function x( state:EsuCallbackState );</code>
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">state</span>:Object</code> &mdash; an optional user-defined state object to be passed to
      the callback method through the EsuCallbackState object.
      </td>
</tr>
</table>
</div>
<a name="restoreVersion()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">restoreVersion</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function restoreVersion(id:<a href="Identifier.html">Identifier</a>, vId:<a href="ObjectId.html">ObjectId</a>, callback:Function, state:Object):void</code><p>
      Restores a version of an object to the base revision (i.e. "promotes" a
      version to the current version)
      </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">id</span>:<a href="Identifier.html">Identifier</a></code> &mdash; the base object
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">vId</span>:<a href="ObjectId.html">ObjectId</a></code> &mdash; the version ID to promote
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">callback</span>:Function</code> &mdash; a callback function with the signature 
      <code>function x( state:EsuCallbackState );</code>
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">state</span>:Object</code> &mdash; an optional user-defined state object to be passed to
      the callback method through the EsuCallbackState object.
      </td>
</tr>
</table>
</div>
<a name="setAcl()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">setAcl</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function setAcl(id:<a href="Identifier.html">Identifier</a>, acl:<a href="Acl.html">Acl</a>, callback:Function, state:Object):void</code><p>
      Sets (overwrites) the ACL on the object.
      </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">id</span>:<a href="Identifier.html">Identifier</a></code> &mdash; the identifier of the object to change the ACL on.
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">acl</span>:<a href="Acl.html">Acl</a></code> &mdash; the new ACL for the object.
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">callback</span>:Function</code> &mdash; a callback function with the signature 
      <code>function x( state:EsuCallbackState );</code>
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">state</span>:Object</code> &mdash; an optional user-defined state object to be passed to
      the callback method through the EsuCallbackState object.
      </td>
</tr>
</table>
</div>
<a name="setUserMetadata()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">setUserMetadata</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function setUserMetadata(id:<a href="Identifier.html">Identifier</a>, metadata:<a href="MetadataList.html">MetadataList</a>, callback:Function, state:Object):void</code><p>
      Writes the metadata into the object. If the tag does not exist, it is 
      created and set to the corresponding value. If the tag exists, the 
      existing value is replaced.
      </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">id</span>:<a href="Identifier.html">Identifier</a></code> &mdash; the identifier of the object to update
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">metadata</span>:<a href="MetadataList.html">MetadataList</a></code> &mdash; metadata to write to the object.
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">callback</span>:Function</code> &mdash; a callback function with the signature 
      <code>function x( state:EsuCallbackState );</code>
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">state</span>:Object</code> &mdash; an optional user-defined state object to be passed to
      the callback method through the EsuCallbackState object.
      </td>
</tr>
</table>
</div>
<a name="updateObject()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">updateObject</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function updateObject(id:<a href="Identifier.html">Identifier</a>, acl:<a href="Acl.html">Acl</a>, metadata:<a href="MetadataList.html">MetadataList</a>, extent:<a href="Extent.html">Extent</a>, data:ByteArray, mimeType:String, callback:Function, state:Object, checksum:<a href="Checksum.html">Checksum</a> = null):void</code><p>
      Updates an object in the cloud.
      </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">id</span>:<a href="Identifier.html">Identifier</a></code> &mdash; The ID of the object to update
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">acl</span>:<a href="Acl.html">Acl</a></code> &mdash; Access control list for the new object. Optional, default
      is NULL to leave the ACL unchanged.
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">metadata</span>:<a href="MetadataList.html">MetadataList</a></code> &mdash; Metadata list for the new object.  Optional,
      default is NULL for no changes to the metadata.
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">extent</span>:<a href="Extent.html">Extent</a></code> &mdash; The new contents of the object.  May be appended
      to later. Optional, default is NULL (no content changes).
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">data</span>:ByteArray</code> &mdash; portion of the object to update.  May be null to indicate
      the whole object is to be replaced.  If not null, the extent size must
      match the data size.
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">mimeType</span>:String</code> &mdash; the MIME type of the content.  Optional, 
      may be null.  If data is non-null and mimeType is null, the MIME
      type will default to application/octet-stream.
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">callback</span>:Function</code> &mdash; a callback function with the signature 
      <code>function x( state:EsuCallbackState );</code>
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">state</span>:Object</code> &mdash; an optional user-defined state object to be passed to
      the callback method through the EsuCallbackState object.
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">checksum</span>:<a href="Checksum.html">Checksum</a></code> (default = <code>null</code>)<code></code> &mdash; if not null, use the Checksum object to compute
      the checksum for the update object request.  If appending
      to the object with subsequent requests, use the same
      checksum object for each request.
      </td>
</tr>
</table>
</div>
<a name="versionObject()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">versionObject</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function versionObject(id:<a href="Identifier.html">Identifier</a>, callback:Function, state:Object):void</code><p>
      Creates a new immutable version of an object.
      </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">id</span>:<a href="Identifier.html">Identifier</a></code> &mdash; the object to version
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">callback</span>:Function</code> &mdash; a callback function with the signature 
      <code>function x( state:EsuCallbackState );</code>
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">state</span>:Object</code> &mdash; an optional user-defined state object to be passed to
      the callback method through the EsuCallbackState object.
      </td>
</tr>
</table>
</div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright">Copyright (c) 2008 EMC</center>
</div>
</body>
</html>
<!--Copyright (c) 2008 EMC-->
